Class ToolBarImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.ui.impl.ToolBarImpl
All Implemented Interfaces:
IPCObject, ToolBar

public class ToolBarImpl extends IPCObjectImpl implements ToolBar
Information provided by the PKI file:

    \class ToolBar
    
    \brief ToolBar is the QDocWindow instatiated in QMainWindow.
    
    \example appWindow().getToolBar()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setVisible

      public void setVisible()
      Information provided by the PKI file:
      
          \brief Shows or hides this widget from view.
          
          \param bVisible, true to show this widget, false to hide it.
          
              
      Specified by:
      setVisible in interface ToolBar
    • count

      public int count()
      Information provided by the PKI file:
      
          \brief Returns the number of action items in this toolbar.
          
          \return int, the number of action items in this toolbar.
          
              
      Specified by:
      count in interface ToolBar
      Returns:
      int Returns a int
    • setItemAtVisible

      public void setItemAtVisible(int index, boolean visible)
      Information provided by the PKI file:
      
          \brief Shows or hides the action item at the specified index.
          
          \param index, the index of the action item.
          \param bVisible, true to show the action item, false to hide it.
          
              
      Specified by:
      setItemAtVisible in interface ToolBar
      Parameters:
      index - Takes in a parameter of index
      visible - Takes in a parameter of visible
    • setItemAtEnabled

      public void setItemAtEnabled(int index, boolean bEnabled)
      Information provided by the PKI file:
      
          \brief Enables or disables the action item at the specified index.
          
          \param index, the index of the action item.
          \param bEnabled, true to enable the action item, false to disable it.
          
              
      Specified by:
      setItemAtEnabled in interface ToolBar
      Parameters:
      index - Takes in a parameter of index
      bEnabled - Takes in a parameter of bEnabled
    • setItemVisible

      public void setItemVisible(String name, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides the specified action item.
          
          \param name, the name of the action item.
          \param bVisible, true to show the action item, false to hide it.
          
              
      Specified by:
      setItemVisible in interface ToolBar
      Parameters:
      name - Takes in a parameter of name
      bVisible - Takes in a parameter of bVisible
    • setItemEnabled

      public void setItemEnabled(String name, boolean bEnabled)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified action item.
          
          \param name, the name of the action item.
          \param bEnabled, true to enable the action item, false to disable it.
          
              
      Specified by:
      setItemEnabled in interface ToolBar
      Parameters:
      name - Takes in a parameter of name
      bEnabled - Takes in a parameter of bEnabled
    • addItem

      public UUID addItem(String text, String iconPath)
      Information provided by the PKI file:
      
          \brief Adds a action button item at the end of the toolbar.
          
          \param text, the name of the button.
          \param iconPath, the full path of the image to use in the button.
          
          \return uuid, the UUID of the action button item that was added.
          
              
      Specified by:
      addItem in interface ToolBar
      Parameters:
      text - Takes in a parameter of text
      iconPath - Takes in a parameter of iconPath
      Returns:
      UUID Returns a UUID
    • removeItemUuid

      public void removeItemUuid(UUID id)
      Information provided by the PKI file:
      
          \brief Removes the action button item with the specified UUID.
          
          \param id, the UUID of the action button item of interest.
          
              
      Specified by:
      removeItemUuid in interface ToolBar
      Parameters:
      id - Takes in a parameter of id
    • getItemByUuid

      public PopupMenuItem getItemByUuid(UUID id)
      Information provided by the PKI file:
      
          \brief Returns the action button item with the specified UUID.
          
          \param id, the UUID of the action button item of interest.
          
          \return MenuItem, the action button item object with the specified UUID.
          
              
      Specified by:
      getItemByUuid in interface ToolBar
      Parameters:
      id - Takes in a parameter of id
      Returns:
      PopupMenuItem Returns a PopupMenuItem
    • setItemObjectEnabled

      public void setItemObjectEnabled(String name, boolean bEnabled)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified action item by using object name.
          
          \param name, the object name of the action item.
          \param bEnabled, true to enable the action item, false to disable it.
          
              
      Specified by:
      setItemObjectEnabled in interface ToolBar
      Parameters:
      name - Takes in a parameter of name
      bEnabled - Takes in a parameter of bEnabled
    • addItemWithName

      public UUID addItemWithName(String text, String iconPath, String name)
      Information provided by the PKI file:
      
          \brief Adds a action button item at the end of the toolbar.
          
          \param text, the name of the button.
          \param iconPath, the full path of the image to use in the button.
          \param name, the object name assigned to the button action.
          
          \return uuid, the UUID of the action button item that was added.
          
              
      Specified by:
      addItemWithName in interface ToolBar
      Parameters:
      text - Takes in a parameter of text
      iconPath - Takes in a parameter of iconPath
      name - Takes in a parameter of name
      Returns:
      UUID Returns a UUID